home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 3
/
Cream of the Crop 3.iso
/
disk
/
gwindos.zip
/
GWIN.DOC
< prev
next >
Wrap
Text File
|
1993-11-12
|
26KB
|
781 lines
GWIN -- Interactive Menu/Help application
Version 1.00 Nov. 1993
Mike Bonnell Systems
Charleston, WV
(304) 744-1084
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
OVERVIEW --
GWIN may be loaded from the command line or a batch file. If you type the
program name with no commandline argument, GWIN looks for the file "GWIN.MNU"
in GWIN's Directory. (the DIR you defined in the "SET GWINDIR=" command.)
You may create your own Help files or Menu files using another filename.ext
and name this file in a commandline argument when GWIN is loaded. GWIN will
look along the DOS PATH for the file you name. You should install a PATH
parameter in AUTOEXEC.BAT that points to the GWIN directory.
Software Requirements:
MS-DOS 5.00 or greater and a Text Editor. (edit.com works fine.)
An additional SET parameter is required in your AUTOEXEC.BAT file. This
parameter tells GWIN where to find its files.
Format is -- SET GWINDIR=[d:]\[path].
d: is the drive letter and path is the Directory name where GWIN was
installed.
If this parameter is not present in AUTOEXEC, GWIN will not load.
Consult your DOS manual for the SET parameter useage.
Hardware Requirements:
AT 386sx or greater, 640k memory, Hard Drive (250k disk space), vga graphics.
Color Monitor. (Vga adapter must be IBM compatible.)
(See the INSTALL.TXT file for complete Installation instructions.
It's included at the end of this document.)
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- SCREENSAVER
==========================================================================
Format is [timeout=nnnnn]
timeout= is the parameter name and nnnnn is a numeric value ranging from
00000 to 32700 in seconds.(A little over 9 hours max.)
Leading zeroes must be present. nnnnn may also be "never".
ex. timeout=00120 will cause the screensaver to activate after 2 minutes of
no keyboard activity.
GWIN's screensaver may be set to invoke at any time you choose.
Multiple <timeout=> parameters may be inserted in a GWIN menu file, each
having a different timeout value. The current timeout value is used until
another <timeout=> is encountered, then the new value is used.
If you do not use the timeout= parameter, the screensaver will be disabled.
If "timeout=" is used, the screensaver will activate only if you have a GWIN
display on the screen.
If an application is loaded, GWIN's screensaver will not go active.
Watch the case of the letters in this parameter -- <timeout=> must be
lower case.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- KEYS
==========================================================================
The Keyboard keys listed here are the only keys supported by GWIN. If any
other key is pressed, a message will display in the status window indicating
that you have pressed an unsupported key.
<Esc> Exit GWIN and return to DOS.
<Up> <Dn> Move the Hi-lite box to the next or previous Menu Item.
<Enter> Load the Program at the Hi-Lite.
<PgUp> Display the previous Screen.
<PgDn> Display the next Screen.
(If <PgDn> results in end of file, then Exit.)
<Home> Display the Contents screen. (See <F2> key.)
<End> Display the last screen.
(This screen cannot be a MENU. It marks end of file. )
<F1> Help. Displays the list of supported Keys. You may then
use <PgUp> or <PgDn> to brouse the HELP FILE.
<F2> Press <F2> then type the name of the HELP subject.
You may type a partial name and GWIN will load the first
match found. Use <PgUp> or <PgDn> to browse.
<F3> About GWIN.
<F4> Use this to exit GWIN HELP and return to your MENU.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- COLOR NAMES
==========================================================================
Colors may be selected with the #Color parameter to set a line to a given
color. You should try to use the dark colors for background, and the light
colors for text. Any combination may be used, though. You could set the
background to #White and the text to #Black (or any other combination)
for special effect.
The Color Names shown here are valid for the TopWin,#color,and StatusLine
Color parameters.
Dark colors:
Black, Blue, Cyan, Red, Green, Brown, Magenta, Dark Gray.
Light colors:
Light Gray, Light Blue, Light Cyan, Light Red, Light Green,
Light Magenta, Yellow, White.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- SIZE=
==========================================================================
Format is [%Size=][nn]
[%Size=] is the parameter name, and [nn] is the text size.
The %Size=nn parameter controls the textsize of all text lines following
until another %Size=nn parameter is encountered.
(The textsize of Menu Items is fixed and cannot be changed.)
Valid sizes are --
Main Window Only ( %Size= parameter )
08 (8pt.)
10 (10pt.)
12 (12pt.)
14 (14pt.)
16 (16pt.)
20 (20pt.)
24 (24pt.)
28 (28pt.)
Title Window Only ( TSize= parameter - see TOPWIN )
07 (8pt.)
09 (10pt.)
11 (12pt.)
13 (14pt.)
15 (16pt.)
19 (20pt.)
23 (24pt.)
27 (28pt.)
The Status line text size cannot be changed.
The text size in the Title Window is controlled by the TSize=nn parameter.
See the TopWin parameter for a more complete description of TSize=nn.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- TEXT COLOR
==========================================================================
Format is #[color]
# is the parameter name, and [color] is the color name.
The #Color parameter sets the textcolor for both text and Menu Items.
The new color remains in effect until another #color parameter is
encountered. You may use the #color parameter to set the highlite box
by inserting a #color as the last line in a Screen Parameter Set.
The highlite box uses the most recent #color encountered.
Dark colors:
Black, Blue, Cyan, Red, Green, Brown, Magenta, Dark Gray.
Light colors:
Light Gray, Light Blue, Light Cyan, Light Red, Light Green,
Light Magenta, Yellow, White.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- TOPWIN
==========================================================================
Format is [@][color1,color2,color3,color4,TSize=[size]
@ is the parameter name, and color[n] is the color name for a screen element.
[size] is the text size for the Title at the top of the screen.
The TopWin Parameter defines the start of a screen parameter set. The values
contained in the parameter define the background color for the Title Window
and the Main Window. The TSize=[size] portion defines the text size for the
Title Window.
Color1 and Color2 define the background color (Color1) and the text color
(Color2) for the Title Window.
Color3 and Color4 define the background color (Color3) and the default text
color (Color4) for the Main Window. (see note below.)
TSize=[size] defines the text size for the Title Window. (TSize=) must appear
as shown here. The case of the letters is important. TS must be CAPS and ize
must be lower case. See the Size parameter description for valid entries.
Note: Main Window text colors may be altered by using the #color parameter.
A comma must separate each operand in the TopWin Parameter.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- MENU/HELP TITLE
==========================================================================
Format is ![Text for the Title]
! is the parameter name. Type the text that will display in the TopWin Title.
The Menu Title displays centered in the Top Window. Use TSize=nn to set the
size of the text. The Title is used during Search to locate a specific HELP
screen for display.
You must define a title if the search function <F2> is to be used.
The title parameter must immediately follow the TopWin parameter. Only one
Title parameter may be used in each Parameter Set.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- STATUS LINE COLOR
==========================================================================
Format is ^[color]
^ is the parameter name. color is a valid color name..
The Status line (at the bottom of the screen) may have its color set by
using the Status Line Color parameter. You may set the color to any valid
color name.
The text color in the status line cannot be altered. GWIN will pick
a contrasting color to use for the text based on the background color you
name.
Only one Status Line Color parameter may be included in a parameter set.
(A Parameter Set consists of all the parameters needed to display one
screen.)
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- MENU ITEM
==========================================================================
Format is -- [xxxyyy] [text]
[xxx] is the graphics x coordinate, and equates to the starting column.
[yyy] is the graphics y coordinate, and equates to the starting row.
[text] is the text to display for this menu item.
Menu Item text size cannot be altered.
The left side of the screen is 0 (zero) and the right side is 639. To show
a menu item at the left side of the screen, X = 000. Normally a menu item
is indented. A starting left side value could be 010 or 020. (One or Two
characters.)
The Top of the screen is 000 and the last location you should try to use is
380. (479 is the bottom limit, but this is under the Status Line.)
Each Item placed on the screen should be spaced far enough apart so that the
Hi-Lite box will not interfere with your text.
Example -- 020120 ProComm
will display the word, "ProComm" slightly in from the left edge of the
screen and about 12 character heights down from the top of the Window.
To place the next line directly below this one, use -- 020140 [text].
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- PROGRAM TO LOAD
==========================================================================
Format is &[d:]\[path]\[progname.ext]
& is the parameter name.
[d:] is the drive letter, [path] is the DOS path, and [progname.ext] is the
name of the program, batchfile, or DOS function to be executed. The maximum
Number of Menu Items per screen is determined by the total length of all
<Program to Load> parameters.
The maximum size of the [path] area is is 766 characters. This is normally
enough to contain 30 - 35 Menu Items per screen. The number of Menu Screens
available is 100 per file if you have the Commercial Version.
You are limited to 2 screens if you have the SHAREWARE Version.
The & (program to load) parameter must immediately follow its' respective
Menu Item. When A Menu Item is selected, GWIN will try to load and execute
whatever is named in this parameter.
The [d:] and [path] portions are optional -- GWIN will search along the DOS
PATH to locate the named program.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- TEXT LINES
==========================================================================
Format is $[xxxyyy] [text]
$ is the parameter name.
[xxxyyy] is the screen coordinates, and [text] is the user text to be
displayed.
An entire screen may be filled with text for use as a HELP FILE, or single
lines (or a single word) may be positioned anywhere on the screen to clarify
something. When combined with the Text Color parameter and the Text Size
parameter, you are able to create custom screens for any purpose.
See the Menu Item Parameter for use of the screen xxxyyy coordinates.)
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- COMMENT LINES
==========================================================================
Format is ;[text]
; is the parameter name. [text] is any text associated with the comment.
GWIN supports standard comment lines that have a semi-colon in column one
and some text following -- (or no text.)
The semi-colon must be in column one, making the entire line a comment.
Partial comment lines are not supported.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- BLANK LINES
==========================================================================
Blank lines may be inserted anywhere to separate a parameter set, or to
separate groupings within a set. Blank lines must contain only spaces.
Use the Comment line for comments.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- SCREEN PARAMETER SET
==========================================================================
The minimum requirements to make a screen work properly are --
1) The first line of each set must be a TopWin parameter.
2) The second Line must be a Menu Title.
3) At least one "%Size=nn" parameter must be included.
4) Other Parameters are optional. Use them as needed.
The parameters used to create an average screen are --
....v....1....v....2....v....3....v....4....v....5....
(TOPWIN) @Light Red,White,Dark Gray,White,TSize=21
(TITLE) !Screen Parameter Set
(COMMENT LINE) ; Screensaver set for 5 minutes
(SCREENSAVER) timeout=00300
(STATUS LINE COLOR) ^Light Red
(BLANK LINE)
(TEXT SIZE) %Size=14
(COLOR) #White
(TEXT LINE) $xxxyyy [text]
(TEXT LINE) $xxxyyy [more text]
(TEXT LINE) $xxxyyy [etc.]
(MENU ITEM) xxxyyy [menu item name]
(PROGRAM TO LOAD) &program.exe
MENU ITEMS and TEXT LINES may appear together in the same parameter set --
or, a parameter set may contain either. If no MENU ITEMS or TEXT LINES
are defined in a set, GWIN displays a blank MAIN WINDOW using the COLOR
information supplied in the TOPWIN parameter.
TOPWIN, TITLE and at least one %Size=nn are mandatory.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- DESIGN A MENU
==========================================================================
Creating a new Menu or HELP file may be accomplished by using the sample
menu file and making new Menu Items and Text Lines corresponding with the
applications you want your people to use. Make a copy of GWIN.MNU. There
are two working Menus contained in this file in different formats, so you
should be able to customize them to suit your needs.
If you keep the original GWIN.MNU file untouched and only modify the
copy, any changes you make will not hurt anything. Experimentation may
be necessary until you become comfortable with GWIN's parameter set and
the screen handling technique used to display your Menus and Help files.
Read the Help portion of "GWIN.DOC" for parameter useage. Look at the
Parameter Sets that are pre-defined in this file and try to model your
first efforts after these.
Don't try to modify GWIN.INI. It is used throughout for online help.
GWIN -- HELP file MENU Application. Mike Bonnell, 1993
==========================================================================
GWIN HELP FILE -- DESCRIPTION OF GWIN
==========================================================================
GWIN was designed to be a textfile display program. The intent was to allow
a user to design HELP files for use in a business environment that could be
displayed in GRAPHICS mode. This mode allows the size of text and text color
to be altered to draw attention to something on the screen. Unlike text mode
applications, the GWIN GRAPHICS environment provides the designer with the
tools needed to write HELP that makes an impact.
Since most users have a Menu Application of some sort, we added that
function to GWIN, making the need for separate Applications unnecessary.
The GWIN Menus may be as simple or complex as you choose.
The screensaver, although not as comprehensive as others, does provide
a <broken glass> display and may be either used or not, as you choose. It
uses a separate program that may be activated from the command line, from
a Menu choice or from within GWIN. The program name is <GSAVR.EXE> and may
be invoked by using the "timeout=" parameter within GWIN.
GDSK.exe is a utility that will calculate and display the free space on a
diskette or hard drive. format is GDSK [d:] (Supports A: - Z:)
We hope you will get some good use out of this application. Although no
known problems exist, we appreciate your input and will resolve problems as
we are made aware of them.
GWIN -- Sample Menu Application and HELP FILE. Mike Bonnell, 1993
INSTALLATION and SETUP --
This Menu/Help file is provided as a guide to the Application Installer who
wishes to make life easier for others. The GWIN Help File/Menu Application
will allow the creation of Help and/or Menus that may be personalized to a
given function. "Useability" is the current term for -- "Gee, this is easy."
With GWIN it is!
GWIN supports 14 keyboard Keys. We tried to support more, but couldn't find
a use for them. (Keys are described in the HELP section of the GWIN.INI file.
Load up GWIN, and press <F1>)
GWIN uses GRAPHICS MODE to display Menus and Text on the screen, so a color
monitor with VGA support is required. 640k of memory and DOS ver. 5.00 or
greater are also required.
GWIN is NOT a 'TSR' program. It is in memory only when you want it to be,
and goes away when you are finished using it. It uses about 92k of memory
when loaded and reports remaining memory that may be used by other programs.
Usually, there will be at least 500k of open memory after GWIN has loaded.
We have loaded and used ParaDox, Quicken, Quattro Pro, Word Perfect,
and others with no problems.
Some games require more memory than is available when GWIN is loaded.
These need to be loaded directly from the command line or a special boot
diskette.
GWIN does not support a mouse. We didn't see enough need, and the extra
memory overhead required would not be helpful. Your other Applications that
do support a mouse are transparent to GWIN. (Use the arrow keys and/or
PgUp/PgDn to navigate GWIN.)
Installing GWIN is easy, too. Just copy the release diskette into a DIR
on your hard disk. The DIR should be defined in your DOS PATH.
(see "INSTALLATION" below.)
To load GWIN, type 'GWIN' at the command line and press 'Enter'. You may
name a Menu/Text file and GWIN will load the file you name. If you type
'GWIN' with no commandline argument, GWIN looks for the file -- 'GWIN.MNU'.
(This is the released SAMPLE MENU file.)
You may create your own Help files or Menu files using another filename.ext
and name this file in a commandline argument when GWIN is loaded. GWIN will
look along the DOS PATH for the file you name.
The Commercial version may have as many as 100 Screen Pages in a single file.
You may also create as many files as you require.
The BBS Version allows 1 usable screen only.
This version of GWIN is the SHAREWARE Version. It is restricted to 2 screens
per file. One of these must be the "END OF FILE" screen, so YOU have 1 screen
page to work with. If you want the commercial version of GWIN, please order
it.
GWIN -- Sample Menu Application and HELP FILE. Mike Bonnell, 1993
..............................................................................
INSTALLATION --
1) Make a new Directory somewhere on your hard disk. You may use any name you
like. ex. From the C:> type -- 'MD GWIN' and press 'Enter'.
2) Copy the GWIN release into this directory.
3) Add this new directory to your AUTOEXEC.BAT [PATH] statement.
4) Add a SET statememt to AUTOEXEC.BAT -- SET GWINDIR=[d:]\[path].
ex. Assume the GWIN dir is named 'GWIN' and is located on your C: drive:
The statement would be - 'SET GWINDIR=C:\GWIN'
The SET statement should appear on a line by itself.
5) Change (or add) FILES=20 and BUFFERS=20 in CONFIG.SYS. (If FILES and
BUFFERS are already 20 or more you don't need to change them.)
6) When this setup is complete, reboot your PC to make the changes permanent.
These changes allow GWIN to be loaded from the command line or a batch file
no matter what your CURRENT DEFAULT directory may be. If you do not make
these changes, GWIN will not load.
..............................................................................
Software Requirements:
MS-DOS 5.00 or greater and a Text Editor. (edit.com works fine.)
If you do not have DOS 5.0 or greater, GWIN will not load.
..............................................................................
Hardware Requirements:
AT 386sx or greater, 640k memory, Hard Drive (500k disk space), vga graphics.
Color Monitor. (Vga adapter must be IBM compatible. Monitor must be at least
640x480 resolution.)
..............................................................................
GWIN -- Sample Menu Application and HELP FILE. Mike Bonnell, 1993
There are three other programs included in this release --
GDSK.EXE -- is a Disk Free-Space analyzer.
It will tell you how much free space remains on the
drive you name at the command line. ex. gdsk b:
It supports drives A: - Z:
GSAVR.EXE -- is GWIN's screensaver. It is a free-standing program
that may be loaded from the command line or is invoked
by GWIN when the timer runs out.
DSPLY.EXE -- A textfile displayer. This program supports the <Up> and
<Dn> arrows and the <Esc> keys only. It will display any
ascii textfile that is less than 32k in size.
useage is -- DSPLY [filename.ext] [\1]
[filename.ext is the name of the file to be displayed,
and [\1] will allow cr/lf and tab characters to be seen.
DSPLY.exe uses the WINDOWBOSS(c) text window interface.
(Ser. # 9302.)
..............................................................................
Other Files on the release disk --
GINSTALL.TXT -- Installation instructions.
GLICENSE.DOC -- License and Ordering Information. Please read.
GWIN.DOC -- GWIN's Manual.
GWIN.INI -- GWIN's control file. (Also contains GWIN HELP.)
GWIN.MNU -- SAMPLE MENU file for GWIN. (Use this to make your own.)
EGAVGA.BGI -- Graphics Driver. (Must be present in GWIN's DIR.)
TRIP.CHR -- Graphics Font file. (Must be present in GWIN's DIR.)
LITT.CHR -- Graphics Font file. (Must be present in GWIN's DIR.)
GREAD.ME -- Startup and/or last minute changes.
GREADME.TOO -- How to contact us.